home *** CD-ROM | disk | FTP | other *** search
/ Dr. Windows 3 / dr win3.zip / dr win3 / PROGRAMR / HDK110L.ZIP / HDKLIB.DOC < prev    next >
Text File  |  1994-01-08  |  14KB  |  308 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                               HyperAct, Inc.                             ║
  5.  ║                               P.O.Box. 5517                              ║
  6.  ║                         Coralville IA 52241 U.S.A                        ║
  7.  ║                          Compuserve - 76350,333                          ║
  8.  ║                        Phone/Fax - (319) 351-8413                        ║
  9.  ║                                                                          ║
  10.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  11.  
  12. *******************************************************************************
  13. *                                   HDKLIB                                    *
  14. * HLPDK V11.0+ System Library Documentation.                                  *
  15. * Last Update - Jan. 08, 1994. (c) 1993, 94 HyperAct Inc.                     *
  16. * Author : Ron Loewy                                                          *
  17. *******************************************************************************
  18.  
  19.  HLPDK V11.0+ System Extention Library.
  20.  
  21.  "Write Once, Help Many!"
  22.       
  23. *******************************************************************************
  24. *                                Introduction                                 *
  25. *******************************************************************************
  26.  
  27. HDKLIB is an extention library to HLPDK that adds functionality to
  28. the HLPDK package, by including special "User Link Templates" that add support
  29. for special links, special graphics, enhanced text attributes and more.
  30.  
  31. HDKLIB uses the HLPDK .USERLINK statement to add functionality to the HLPDK
  32. system, and offer simple methods to create graphic links, normal text links,
  33. 256 color bitmap support, video, CDAudio, Multimedia MCI interface etc ..
  34.  
  35. WINHELP users have access to the complete macro API, using !xxx user links.
  36.  
  37. *******************************************************************************
  38. *                                  Warranty                                   *
  39. *******************************************************************************
  40.  
  41. There is no warranty what so ever, The package is supplied as is,
  42. The distributor (HyperAct Inc.), or the author (Loewy Ron), are not, 
  43. and will not be responsible for any damages, lost profits, 
  44. or inconveniences caused by the use, or inability to use this package. 
  45. The use of the program is at your own risk. 
  46. By using (or attempting to use) the package you agree to this.
  47.  
  48. *******************************************************************************
  49. *                                Distribution                                 *
  50. *******************************************************************************
  51.  
  52. HDKLIB is free to registered users of HLPDK. If you are not a HLPDK registered
  53. user, you are allowed to evaluate HLPDK and HDKLIB for a reasonable amount of
  54. time (Up to 1 Month).
  55.  
  56. Please consult the HLPDK.DOC and HLPDK.REG files that come with the evaluation
  57. package of HLPDK.
  58.  
  59. *******************************************************************************
  60. *                                   Contact                                   *
  61. *******************************************************************************
  62.  
  63. Please contact :
  64.  
  65.         HyperAct Inc.  
  66.         P.O.Box 5517
  67.         Coralville IA 52241
  68.         U.S.A
  69.  
  70.         E-Mail  : Compuserve - 76350,333
  71.         Phone   : (319) 351-8413
  72.            
  73. To contact the author directly please write to : 
  74.  
  75.         Loewy Ron
  76.  
  77.         E-Mail  : Compuserve - 100274,162
  78.  
  79. *******************************************************************************
  80. *                                    Setup                                    *
  81. *******************************************************************************
  82.  
  83. Copy the files to the directory you use to keep HLPDK.
  84.  
  85. Every help/hypertext/hypermedia database you use with HDKLIB should include
  86. a line of the format :
  87.  
  88. .include [d:\path\to\hdklib-directory\]HDKLIB.HDF
  89.  
  90. and all the HDKLIB functions are available.
  91.  
  92. *******************************************************************************
  93. *                                  Operation                                  *
  94. *******************************************************************************
  95.  
  96. After you have .INCLUDEd the HDKLIB.HDF library in your HDF source, you
  97. can use the following NEW functions and templates :
  98.  
  99. winHelp
  100. -------
  101.  
  102. Text Attributes :
  103.  
  104. boldText        - Display Text in Bold.     ~Text to display~boldText~
  105. italicText      - Display Text in Italic    ~Text to display~italicText~
  106. underlineText   - Display Text underlined   ~Text to display~underlineText~
  107. boldItalicText  - Display Bold Italic Text  ~Text to display~boldItalicText~
  108. fontText        - Display Text in font X    ~Text in font 3~fontText(3)~
  109.  
  110. Links :
  111.  
  112. NormalTextLink  - Link not underlined       ~Click Here~NormalTextLink(linkId)~
  113. NormalTextPopup - Popup not underlined      ~Click Here~NormalTextPopup(popupId)~
  114.  
  115. graphicLink     - Link connected to bitmap  ~Text~graphicLink(myBmp LinkId)~
  116.                   Should declare a .GRAPHIC myBmp c:\..\myfile.bmp
  117. graphicPopup    - Popup connected to bitmap ~Text~graphicPopup(myBmp PopupId)
  118.                   Should declared a .GRAPHIC myBmp c:\..\myfile.bmp
  119.  
  120.  
  121. Macros :
  122.  
  123. Complete WINHELP macro API reference is provided, if there is a macro such
  124. as the About() WINHELP macro, you can rfer to it with the !about user link.
  125.  
  126. e.g. - Using the ExecProgram WINHELP macro, to start NOTEPAD.EXE in minimized
  127.        mode can be used with !execProgram(notepad.exe 2)
  128.  
  129. For the complete macro reference, please consult the WINHELP macro 
  130. documentation in the programming reference guide that came with your
  131. development package, or the Microsoft WHAG package.
  132.  
  133. WINHELP Macros Quick Referece -
  134.  
  135. About                - Displays the About dialog box 
  136.                       e.g. ~text~!about~      
  137. AddAccelerator        - Assigns a macro to an accelerator key 
  138.                       e.g. ~text~!addAccelerator(0x73 7 'About()')~
  139. Annotate        - Displays Annotation dialog box 
  140.                       e.g. ~text~!annotate~
  141. AppendItem        - Appends a menu item 
  142.                       e.g. ~text~!appendItem(ID_MENU ID_ITEM &Item 'JI("","TOP")'~
  143. Back                - Displays previous topic in the history list 
  144.                       e.g. ~text~!back~
  145. BookmarkDefine        - Displays the Define dialog box 
  146.                       e.g. ~text~!bookmarkDefine~
  147. BookmarkMore        - Displays the More dialog box 
  148.                       e.g. ~text~!bookmarkMore~
  149. BrowseButtons        - Adds browse buttons 
  150.                       e.g. ~text~!browseButtons~
  151. ChangeButtonBinding - Assigns a macro to a button 
  152.                       e.g. ~text~!ChangeButtonBinding(btn_contents 'JI("","NEWTOP")')~
  153. ChangeItemBinding   - Assigns a macro to a menu item 
  154.                       e.g. ~text~!changeItemBinding(DISP_ABOUT About())~
  155. CheckItem        - Checks a menu item 
  156.                       e.g. ~text~!checkItem(ID_ITEM)~
  157. CloseWindow        - Closes a window 
  158.                       e.g. ~text~!closeWindow(ID_WIN)~
  159. Contents        - Displays the Contents topic                             
  160.                       e.g. ~text~!contents~
  161. CopyDialog        - Displays the Copy dialog box 
  162.                       e.g. ~text~!copyDialog~
  163. CopyTopic        - Copies current topic to the clipboard 
  164.                       e.g. ~text~!copyTopic~
  165. CreateButton        - Adds a new button to the button bar 
  166.                       e.g. ~text~!createButton(ID_BUTTON BUT_NAME JI("","TOP")~
  167. DeleteItem        - Removes a menu item 
  168.                       e.g. ~text~!deleteItem(ID_ITEM)~
  169. DeleteMark        - Deletes a text marker 
  170.                       e.g. ~text~!deleteMark(Marker)~
  171. DestroyButton        - Removes a button from the button bar 
  172.                       e.g. ~text~!destroyButton(ID_BUTTON)~
  173. DisableButton        - Disables a button 
  174.                       e.g. ~text~!disableB